home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / image / stview11.zip / STARVIEW.DOC < prev    next >
Text File  |  1996-06-21  |  9KB  |  217 lines
  1.                   StarView Archive Text File Snooper V1.1
  2.                            Public Domain Software
  3.               (!) 1996 Larry Monte/StarLab Systems Software
  4. -----------------------------------------------------------------------------
  5.  
  6. IF YOU ARE UPGRADING FROM V1.0, SEE UPGRADE DOC!
  7.  
  8.  
  9. GUARANTEES:
  10. -----------
  11.               None expressed or implied. If StarView works for
  12.               you...great. If not, feel free to modify the code
  13.               to work on your system. 
  14. -----------------------------------------------------------------------------
  15.  
  16. What is StarView?:
  17. ------------------
  18.               StarView is a replacement for your VIEW_FILES command
  19.               in your MAX V3.x file area. It will not only show users
  20.               any text files contained on your system, but will also
  21.               allow them to snoop within archives for text files.
  22.               This is basically a stand-alone version of a feature
  23.               included in StarBar, a lightbar file selecting utility
  24.               released earlier.
  25. -----------------------------------------------------------------------------
  26.  
  27. OS/2 Sysops:
  28. ------------
  29.               Although I haven't heard of any problems with my
  30.               method of external archive snooping, they have
  31.               not been tested extensively on OS/2 systems.
  32.               My main concern is the *.CMD files which are used for
  33.               extracting files from within Archives. Because I have
  34.               no access to an OS/2 system, I could not test these
  35.               files properly.
  36.               I suspect they may work, but if they don't you will
  37.               have to modify the CMD files yourself.
  38.               Further, if you do get them to work (or the originals
  39.               work in the first place) please NetMail me the
  40.               corrections so I can include them in future releases!
  41.  
  42. -------------==============Basic Setup Instructions=============-------------
  43.  
  44. NOTE: I suggest everyone to setup StarView by the proceedures outlined below.
  45.       This will make it easier to track down problems if everyone uses the
  46.       program the same way.
  47.  
  48. 1) Make sure ALL your archivers are somewhere in your DOS path! You need to
  49.    do this for your daily BBS operations, so this _should_ be done already
  50.  
  51. 2) Make sure you have the MEX_INCLUDE environment set in your autoexec.bat
  52.    file. Your autoexec.bat should have this line:
  53.  
  54. SET MEX_INCLUDE=c:\max\m
  55.                 ^^^^^^^^^
  56.                 Should be set to where you keep your *.MH MEX files...
  57.  
  58.    If you don't have this set, add the above line to autoexec.bat and reboot
  59.    your computer!
  60.  
  61. 3) Unpack the STVIEW10.ZIP archive into a directory off your main BBS dir
  62.    called STARVIEW.
  63.    Here, it's : C:\MAX\STARVIEW
  64.  
  65.    NOTE: If you run StarBar V2.0 on your system, StarView will be quite
  66.          happy sharing that directory!
  67.  
  68. 4) MOVE (not copy) both STARVIEW.LH and STARVIEW.MH into your ..\m directory.
  69.    Here, it's : C:\MAX\M
  70.    Do not leave a copy of these files in the STARVIEW directory. Make sure
  71.    they are in your ..\m dir ONLY!
  72.  
  73. 5) Change to your ..\lang directory and load your main <language>.mad file
  74.    (here it's ENGLISH.MAD) into your favorite text editor.
  75.    NOTE: See below on creating other StarView language files for multiple
  76.          language systems.
  77.    At the end of your language file is a section called "User Heap". You
  78.    may see another include file there. Add the following to this section:
  79.  
  80. ; Include any user heaps here
  81.  
  82. <Other includes may be defined here>
  83. #include <../m/starview.lh>
  84.  
  85.    I know there is a USER.LH file where other language files can be defined
  86.    but to keep the least amount of confusion, put the above include line
  87.    in the main <language>.mad file.
  88.  
  89. 6) Compile your language file:
  90.  
  91. MAID <Your language here>.mad
  92.  
  93. 7) Change to your ..\m dir and load STARVIEW.MH into your favorite text
  94.    editor.
  95.    This file contains #defines that _MUST_ be changed before you compile
  96.    and run StarView.
  97.    The StarView.MH file contains all the information about how to change
  98.    the #defines. Just follow those and you should be okay.
  99.  
  100. 8) After you are finished with the MH file, change to the main StarBar
  101.    directory and compile StarView using:
  102.  
  103. MEX STARVIEW
  104.  
  105. 9) Make the following changes to your FILE SECTION in MENUS.CTL:
  106.  
  107.      MEX             StarView\StarView          Normal "View Text Files"
  108.      ^^^^^^^^
  109.         This replaces the FILE_VIEW entry in the FILE section.
  110.  
  111. 10) SILT MAX
  112.  
  113. 11) Run StarView on each node once. You need to do this once so StarView
  114.     can create a node-specific work directory.
  115.     StarView will report there are no Text or Doc files on the first run,
  116.     but will work fine after that.
  117.  
  118.     NOTE: This won't need to be done if you put StarView in the same dir
  119.           as StarBar (if you run StarBar) as you likely did this already
  120.           during the StarBar setup.
  121.  
  122. That's it. You should have a fully operational copy of StarView working on
  123. your BBS!
  124. -----------------------------------------------------------------------------
  125. ----------------------About the BAT/CMD/GUS/ACL Files------------------------
  126.  
  127. The distribution setup of StarView uses batch files which do the external
  128. archive snooping/unpacking. The current *.BAT *.CMD files will work without
  129. need of 3rd party utils. (You only need the archive programs themselves)
  130.  
  131. Included are *.GUS(DOS) & *.ACL(OS/2) files. These are included in case you
  132. wish to use GUS or ACLE to do your archive unpacking. In this case, simply
  133. rename the *.GUS (for DOS) files to *.BAT or *.ACL (for OS/2) files to *.CMD.
  134.  
  135. EG:(DOS)
  136.    You have UNPACK.BAT - Delete or rename this
  137.  
  138.             UNPACK.GUS - Copy or rename these to UNPACK.BAT
  139.  
  140.  
  141.    (OS/2)
  142.    You have UNPACK.CMD - Delete or rename this
  143.             
  144.             UNPACK.ACL - Copy or rename these to UNPACK.CMD
  145.  
  146. NOTE: If you use GUS or ACLE, they _MUST_ be in your main BBS directory, not
  147.       in the StarView dir!! (The *.BAT/*.CMD's should be in your StarView
  148.       directory)
  149.  
  150. NOTE: Both GUS and ALCE are requestable here @ 1:253/232 as "GUS" and
  151.       "ACLE"
  152. -----------------------------------------------------------------------------
  153. -------------------Adding/Modifying StarView Language Files------------------
  154.  
  155.   StarView is capable of using multiple language files. Once you have your
  156. primary language file using StarView.LH, you can copy this file to another
  157. name and include it in other language files.
  158.   However, if you don't have translated StarView language files, I recommend
  159. including StarView.LH in all your "user heaps" in all the language files
  160. you run.
  161.   If you have translated StarView language files, include the file in the
  162. appropriate language files.
  163.  
  164.   For instance, say you have a French language file for StarView called
  165. STARVFR.LH. Put it in your ..\m dir and include this filename in your
  166. french language "user heap". (Same method as described above)
  167.   MAID the French language file, and try it out. Run StarView under French
  168. and have a look.
  169.  
  170.  
  171.   Translating:
  172.   ------------
  173.  
  174.   Translating the StarView.LH file shouldn't prove to be too difficult, but
  175. there are a few things you should keep in mind:
  176.  
  177.   - Take care to preserve the control characters (EG: "\n\n") These are
  178.     line feed characters and may have undesired effects on other strings
  179.     if omitted.
  180.   - Make sure you don't touch the   =starview   statement which appears
  181.     after the version #define.
  182.   - Enclose all text in quotes (not the colour words)
  183.   - End each string with a   ;
  184.  
  185. -----------------------------------------------------------------------------
  186. ------------------------------Common Problems--------------------------------
  187.  
  188. Q: When I compile using "MEX STARVIEW", I get litterally _HUNDREDS_ of errors!
  189.  
  190. A: You either don't have "SET MEX_INCLUDE" defined in your AUTOEXEC.BAT file
  191.    or you've put the STARVIEW.MH file somewhere MEX can't see it. Make sure
  192.    STARVIEW.MH is in your ..\m directory, and that MEX_INCLUDE is defined
  193.    (see above or